package org.gvp.common.annotation;

import java.lang.annotation.*;

/**
 * 此注解为api注解,只可以在Controller类的方法上使用,用于标记一个方法是否解析为api文档
 * 该注解提供方法解释和方法参数返回值的解释
 * @since v1.0 2021/1/5
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Operation {
    /**
     * 默认值方法说明,如果方法没有参数,返回值简单不需要要解释直接使用此值
     */
    String value() default "";

    /**
     * 方法的参数说明,如果方法没有参数或者参数简单,此值可以不用设置
     */
    String param() default "";

    /**
     * 方法的功能的详细说明
     */
    String desc() default "";

    /**
     * 方法的返回值说明,如果方法返回值简单,此值可以不用设置
     */
    String returnDesc() default "";
}
